Get Task

This request lets you retrieve the status of the current task for those endpoints whose response returns the Task Id:

■ Upload Operator Connect Numbers to Customer
■ Release Operator Connect Numbers from Customer
■ Create Customer from Lead
■ Upgrade Operator Connect Customer License

You can see examples for task requests under the descriptions for each of the above requests.

URL

Copy 
{{baseUrl}}/<tenantui>/api/v2/task​/{taskid}

HTTP Method

GET

Request Headers

Attribute

Type

Description

X-Ovoc-Channel-Id

integer

The Live Platform channel "id". When specified, data retrieval is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

You can alternatively use "X-IAM-Account-Id" which as result generates an identical response.

X-IAM-Account-Id

string

The Live Platform "iamAccountId" of the channel. When specified, data retrieval is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

Request Parameters

Parameter

Type

Description

taskid

String($uuid)

(path)

The Job id of the task.

HTTP Responses

■ 200 OK

Parameter

Type

Description

totalNumbersCount

integer

The number of phone numbers added or removed.

id

string

Task id

status

string

Task status is one of the following:

■ In Progress
■ Completed Success
■ Completed Failed

details

string

See specific examples for the relevant requests:

■ Upload Operator Connect Numbers to Customer
■ Release Operator Connect Numbers from Customer
■ Create Service from Lead Overview

ExecutionMessages

list array

List array including the following:

■ level
■ message

level

string

One of the following values:

■ Information
■ Error

message

string

See specific examples for the relevant requests:

■ Upload Operator Connect Numbers to Customer
■ Release Operator Connect Numbers from Customer
■ Create Service from Lead Overview

outputData

List array

Operator Connect Patch Upgrade: "UmpCustomerGuid"

outputData

List array

Operator Connect Number Upload: "CreateTime" "CompleteTime"; "OcUploadNumberResult"; "NumbersUploaded"; "WorkflowVersion": 3

outputData

List array

Operator Connect Number release: "MsReleaseJobId; "MsTenantId"; "MsReleaseJobStatus; "UmpReleaseJobStatus".

MsReleaseJobId

string

Task Job Id on Microsoft Operator Connect platform.

MsTenantId

string

Azure tenant customer tenant Id

MsReleaseJobStatus

string

Microsoft Task Id

UmpReleaseJobStatus

string

Live Platform Release Job status. One of the following:

■ Completed Successful
■ In Progress
■ Completed Failed

MsReleaseJobCreatedAt

string($date-time)

Date and time that the job was created on the Microsoft Operator Connect platform.

MsReleaseJobCreatedBy

string

Microsoft Tenant App Id of the Live Cloud REST API Enterprise application (see Authenticating Connection Using Postman).

PendingIntervention

boolean

Indicates if there is an active Live Platform alarm on this customer tenant:

■ True-Active alarm
■ False-OVOC alarm cleared

Example Request

Copy 
{{baseUrl}}/api/v2/task/wst_e54bbafa-d120-4774-bc6f-acfd2eff0d18

Example Response

Copy 
{
    "id": "wst_e54bbafa-d120-4774-bc6f-acfd2eff0d18",
    "status": "CompletedSuccess",
    "details": [
        "Converted"
    ],
    "executionMessages": [
        {
            "level": "Information",
            "message": "SBC sbc-onboarding done for site SIPTest4."
        },
        {
            "level": "Information",
            "message": "Site created in Ovoc"
        }
    ],
    "outputData": {
        "umpCustomerGuid": "993186ab-3711-4579-80d1-e2d18c6ec86c"
    },
    "createTime": "0001-01-01T00:00:00"
}